home *** CD-ROM | disk | FTP | other *** search
/ MACD 5 / MACD 5.bin / workbench / tools / czesc_2 / manual / manual.doc < prev    next >
Text File  |  1994-07-20  |  10KB  |  242 lines
  1.  
  2.                 Kurzanleitung zu Manual 1.00
  3.                 ============================
  4.  
  5.                     (von Thomas Egeter)
  6.  
  7.  
  8.  
  9.  
  10. Copyright und Ähnliches
  11. -----------------------
  12.  
  13.     Copyright (c) 1994, Thomas Egeter, All Rights Reserved
  14.  
  15.     Das Programm Manual darf frei kopiert und verwendet werden, falls
  16.     folgende Bedingungen eingehalten werden:
  17.  
  18.     1) Das Programm Manual und diese Dokumentation darf nicht verändert
  19.        werden. Ausgenommen davon sind natürlich die Merkmale (ToolTypes)
  20.        in der dazugehörigen Icondatei. Ausgenommen ist auch eine Komprimierung
  21.        zum Datentransfer und zur Archivierung.
  22.  
  23.     2) Das Programm Manual darf nur mit seiner Dokumentation (dieser Text)
  24.        weiterverbreitet werden.
  25.  
  26.     3) Es darf kein Geld (bis auf eine angemessene, geringe Kopiergebühr)
  27.        für das Weitergeben des Manual-Programmes verlangt werden.
  28.  
  29.     4) Wer das Programm Manual ab und zu verwendet, verpflichtet sich dazu,
  30.        dem Autor (Adresse siehe unten) eine Postkarte zu schicken.
  31.  
  32.     Der Autor ist nicht verantwortlich für irgendeinen Schaden, der durch
  33.     Manual angerichtet oder ermöglicht wurde oder wird. Manual wurde zwar
  34.     intensiv getestet und alle gefundenen Fehler wurden beseitigt, aber wer
  35.     weiß: Irgendwo lauert sicher noch ein kleiner, gemeiner Bug, der nur darauf
  36.     wartet, alle erreichbaren Daten genüßlich zu verfälschen, den Monitor
  37.     durchbrennen zu lassen oder die Milch im Kühlschrank sauer werden zu
  38.     lassen ...
  39.  
  40.     Kurz gesagt: Ich übernehme keine Garantie für das Programm 'Manual' !
  41.  
  42.  
  43. Allgemeines
  44. -----------
  45.  
  46.     Manual dient dazu, zu den Programmen, die sich im Laufe der Zeit auf der
  47.     Festplatte angesammelt haben, einfach und bequem die dazugehörigen
  48.     Anleitungen zu suchen und anzuzeigen (Ihr habt doch alle Anleitungen
  49.     sorgfältig aufgehoben ? :-). Die Anleitungen sollten dazu in einigen
  50.     wenigen Unterverzeichnissen gesammelt worden sein.
  51.     Es gibt drei Modi, in denen Manual arbeiten kann:
  52.         - CLI-Modus
  53.         - Workbench-Modus
  54.         - AppIcon-Modus
  55.     Im CLI-Modus wird Manual vom CLI aus aufgerufen (:-). Die Programme, zu
  56.     denen die Anleitungen gesucht werden sollen, werden in der Kommandozeile
  57.     als Parameter übergeben. Im Workbench-Modus werden die Argumente per
  58.     Multiselect (Shift-Taste niederhalten und mehrere Programmicons anklicken)
  59.     übergeben. Im AppIcon-Modus legt Manual sich ein AppIcon auf der Workbench
  60.     an, auf das dann Programmicons gelegt werden können.
  61.     Voreinstellungen, wie z.B. Suchpfade, Anzeigeprogramme, etc. werden in
  62.     allen Modi (auch aus dem CLI-Modus!) aus der Icondatei des Manualprogramms
  63.     gelesen. Das Manual-Programm muß also _immer_ ein Icon besitzen. Es werden
  64.     sonst mehr oder (für die meisten Leute) weniger sinnvolle Defaultwerte
  65.     verwendet.
  66.  
  67.  
  68. Aufruf
  69. ------
  70.  
  71.     1) vom CLI
  72.  
  73.         a)  Manual Programm1 Programm2 Programm3 ... ProgrammN
  74.             sucht die Anleitungen zu Programm1 ... ProgrammN und zeigt
  75.             sie an, wenn sie gefunden werden.
  76.  
  77.         b)  Manual -appicon
  78.             legt ein AppIcon auf der Workbench an, koppelt sich dabei aber
  79.             nicht vom CLI ab. Will man dies erreichen, so muß man folgenden
  80.             Aufruf verwenden:
  81.             Manual >NIL: <NIL: -appicon
  82.  
  83.     2) von der Workbench
  84.  
  85.         a)  Doppelklick auf das Manual-Icon
  86.             legt ein AppIcon auf der Workbench an. Zu jedem Programm, dessen
  87.             Icon auf das AppIcon gelegt wird, wird die Anleitung gesucht.
  88.  
  89.         b)  Multiselect
  90.             Einfaches Anklicken des Manual-Icons, dann Drücken und Nieder-
  91.             halten der Umschalttaste, dann einfaches Anklicken einer Reihe
  92.             weiterer Icons und Doppelklick beim letzten Icon dieser Reihe.
  93.             Die Anleitungen aller angeklickten Programme werden, falls
  94.             gefunden, angezeigt.
  95.  
  96.     Der bzw. die Suchpfade für die Anleitungen werden den Merkmalen des
  97.     Manual-Icons entnommen. Wird dort nichts gefunden, wird ein Default-
  98.     pfad voreingestellt.
  99.  
  100.  
  101. Merkmale (ToolTypes)
  102. --------------------
  103.  
  104.     1)  PFAD#=Pfad,Endung,Programm  (Allgemeine Form)
  105.  
  106.         #       steht für eine Zahl.
  107.                 Für den ersten Pfad muß die Zahl 1 lauten, für den
  108.                 zweiten 2 usw. Wird z.B. ein PFAD7 erstellt, so müssen
  109.                 PFAD1 bis PFAD6 existieren, sonst wird PFAD7 ignoriert.
  110.  
  111.         Pfad    der Pfad, in dem gesucht werden soll.
  112.                 Er muß mit ':' bzw. '/' enden.
  113.                 Beispiel: Docs:Anleitungen/
  114.  
  115.         Endung  die Endung, die den Namen der Anleitung vom Namen des
  116.                 Programms unterscheidet.
  117.                 Beispiel:   Endung lautet '.guide'.
  118.                             Heißt das Programm 'MuchMore', dann
  119.                             wird nach 'MuchMore.guide' gesucht.
  120.  
  121.         Programm    das Programm (incl. Pfad), das zur Anzeige der
  122.                 Anleitung verwendet werden soll.
  123.                 Beispiel: SYS:Utilities/AmigaGuide
  124.  
  125.         Pfad, Endung und Programm müssen durch Kommas getrennt werden !!
  126.  
  127.         komplettes Beispiel:
  128.                      PFAD1=Docs:,.doc,SYS:Utilities/More
  129.                      PFAD2=Docs:Guides/,.guide,SYS:Utilities/AmigaGuide
  130.                      PFAD3=Docs:DVI/,.dvi,TeX:ShowDVI
  131.  
  132.         Defaultwert: PFAD1=Docs:,.doc,SYS:Utilities/More
  133.  
  134.     2)  APPICON_X   die X-Koordinate des AppIcons
  135.                     Beispiel: APPICON_X=100
  136.  
  137.     3)  APPICON_Y   die Y-Koordinate des AppIcons
  138.                     Beispiel: APPICON_Y=22
  139.  
  140.     4)  APPNAME     der Name, der unterhalb des AppIcons erscheint.
  141.                     Beispiel: APPNAME=man
  142.                     Defaultwert: der Programmname
  143.  
  144.     5)  APPICON     APPICON=Default
  145.                         Als AppIcon wird das Manual.info-Icon verwendet.
  146.                     APPICON=Intern
  147.                         Als AppIcon wird ein internes, im Programm
  148.                         gespeichertes Icon verwendet.
  149.                     APPICON=Extern
  150.                         Ein beliebiges Icon kann als AppIcon verwendet werden.
  151.                         Welches verwendet wird, wird durch das Merkmal
  152.                         ICONFILE bestimmt (siehe unten).
  153.                     Defaultwert: APPICON=Default (wen wundert's :-)
  154.  
  155.     6)  ICONFILE    Pfad und Name eines Icons ohne angehängtes '.info'. Wird
  156.                     als AppIcon verwendet, falls das Merkmal APPICON=Extern
  157.                     existiert.
  158.                     Beispiel: ICONFILE=RAM:Disk
  159.  
  160.     7)  MELDUNG     gibt an, ob eine Meldung erscheinen soll, wenn nicht alle
  161.                     Anleitungen zu den Programmen gefunden wurden.
  162.                     Beispiele:   MELDUNG=Aus
  163.                                  MELDUNG=Ein
  164.                     Defaultwert: MELDUNG=Ein
  165.  
  166.     8)  REQUESTER   gibt an, ob beim Zugriff auf ein Laufwerk der System-
  167.                     requester 'Please insert Volume XXX ...' erscheinen soll
  168.                     (um evtl. eine fehlende Diskette nachzuschieben) oder
  169.                     nicht. Wenn nicht, wird so getan, als ob das gesuchte
  170.                     Dokument nicht unter diesem Pfad zu finden ist.
  171.                     Beispiele:   REQUESTER=Aus
  172.                                  REQUESTER=Ein
  173.                     Defaultwert: REQUESTER=Ein
  174.  
  175.     9)  DONOTWAIT   ist nötig, wenn das Programm im WBStartup-Verzeichnis
  176.                     liegt. Der Workbench wird damit mitgeteilt, daß sie nicht
  177.                     auf das Programmende warten soll.
  178.  
  179.  
  180. Arbeitsweise
  181. ------------
  182.  
  183.     Manual nimmt den Namen des übergebenen Programmes und geht der Reihe nach
  184.     alle Pfade, von PFAD1 beginnend, der Reihe nach durch, hängt dabei jeweils
  185.     die zum Pfad gehörende Endung an den Programmnamen und sucht eine Datei
  186.     mit diesem Namen. Falls sie gefunden wird, wird der Suchvorgang beendet
  187.     und die Datei mit dem entsprechenden Anzeigeprogramm angezeigt.
  188.     Vorsicht: Wenn zu einem Programm mehrere Anleitungen existieren (z.B.
  189.               MuchMore.doc _und_ MuchMore.guide) so wird nur das angezeigt,
  190.               das zuerst gefunden wird.
  191.  
  192.  
  193. Einschränkungen
  194. ---------------
  195.  
  196.     -   Manual braucht mindestens AmigaOS 2.0
  197.     -   läuft momentan nur mit deutschen Texten
  198.     -   keine Möglichkeit zum Ändern der Einstellungen im AppIcon-Modus,
  199.         ohne das Programm zu beenden.
  200.         (Ein GUI dafür ist schon längst vorgesehen [siehe Prefs-Button], aber
  201.         ich hab' momentan wenig Zeit und echt keine Lust mich mit gadtools.lib
  202.         anzufreunden -> wie wär's mit netten emails oder Postkarten ;-).
  203.  
  204.  
  205. Was wird irgenwann einmal gemacht ?
  206. -----------------------------------
  207.  
  208.     -   GUI zum Einstellen der Pfade
  209.     -   Anleitung als Amigaguide-Dokument
  210.     -   Lokalisierung (Anpassen an verschiedene Sprachen)
  211.  
  212.  
  213. Autor
  214. -----
  215.  
  216.     Ich bin erreichbar unter ...
  217.  
  218.         email:      fh0015@rfhs1012.fh.uni-regensburg.de
  219.  
  220.         IRC:        Diogenes
  221.  
  222.         snail-mail: Thomas Egeter
  223.                     Am Alten Dorf 31
  224.                     D - 92637 Weiden
  225.                     Germany/ Deutschland
  226.  
  227.  
  228. Dank an
  229. -------
  230.  
  231.     Douglas Adams       für den 'Hitchhiker's Guide'
  232.  
  233.     Volker Milsch       für sein nettes Icon, das jetzt jeder als internes
  234.                         Icon bewundern kann ;-)
  235.                         für seine Betatest-Kommentare ("Das verhält sich so
  236.                         komisch, wenn ..." )
  237.  
  238.     Reinhard            für den Tip mit dem Pseudo-Fenster
  239.  
  240.     Rotti               für seine Nörgelei ("_ICH_ hätt's sooo gemacht")
  241.                         nicht nur beim Beta-Testen (don't panic :)))
  242.